<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>Board game project: Piece Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">Board game project
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">A Board game software</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">Piece Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A <a class="el" href="class_piece.html" title="A Piece class.">Piece</a> class.  
 <a href="class_piece.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_piece_8h_source.html">Piece.h</a>&gt;</code></p>

<p><a href="class_piece-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae1c624cc7e7e01c221982b9093198096"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#ae1c624cc7e7e01c221982b9093198096">Piece</a> (int player=-1, char type= '.')</td></tr>
<tr class="memdesc:ae1c624cc7e7e01c221982b9093198096"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="class_piece.html" title="A Piece class.">Piece</a> Constructor.  <a href="#ae1c624cc7e7e01c221982b9093198096"></a><br/></td></tr>
<tr class="memitem:ae9d83d9e61af925e47615dfd74e30f83"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#ae9d83d9e61af925e47615dfd74e30f83">getType</a> ()</td></tr>
<tr class="memdesc:ae9d83d9e61af925e47615dfd74e30f83"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Type.  <a href="#ae9d83d9e61af925e47615dfd74e30f83"></a><br/></td></tr>
<tr class="memitem:a6d5a10260ce443eced0a02d3df230568"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#a6d5a10260ce443eced0a02d3df230568">setType</a> (char type)</td></tr>
<tr class="memdesc:a6d5a10260ce443eced0a02d3df230568"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Type.  <a href="#a6d5a10260ce443eced0a02d3df230568"></a><br/></td></tr>
<tr class="memitem:acc0b7c99053c361cd55f0231e3b6e272"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#acc0b7c99053c361cd55f0231e3b6e272">getPlayer</a> ()</td></tr>
<tr class="memdesc:acc0b7c99053c361cd55f0231e3b6e272"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get Player.  <a href="#acc0b7c99053c361cd55f0231e3b6e272"></a><br/></td></tr>
<tr class="memitem:ae696e3d3041f9dd79f82ffda0417f3e4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#ae696e3d3041f9dd79f82ffda0417f3e4">setPlayer</a> (int player)</td></tr>
<tr class="memdesc:ae696e3d3041f9dd79f82ffda0417f3e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set Player.  <a href="#ae696e3d3041f9dd79f82ffda0417f3e4"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class that defines a board game piece </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ae1c624cc7e7e01c221982b9093198096"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_piece.html#ae1c624cc7e7e01c221982b9093198096">Piece::Piece</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>player</em> = <code>-1</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>type</em> = <code>'.'</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructs a board game <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. Default <a class="el" href="class_piece.html" title="A Piece class.">Piece</a> has player as -1 and type as '.' </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">player</td><td>The owner of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. Also used when outputting the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="acc0b7c99053c361cd55f0231e3b6e272"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="class_piece.html#acc0b7c99053c361cd55f0231e3b6e272">Piece::getPlayer</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the owner of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </p>
<dl class="section return"><dt>Returns:</dt><dd>The owner of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a> as an integer. </dd></dl>

</div>
</div>
<a class="anchor" id="ae9d83d9e61af925e47615dfd74e30f83"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="class_piece.html#ae9d83d9e61af925e47615dfd74e30f83">Piece::getType</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Gets the type of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </p>
<dl class="section return"><dt>Returns:</dt><dd>Returns the type as a char. </dd></dl>

</div>
</div>
<a class="anchor" id="ae696e3d3041f9dd79f82ffda0417f3e4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_piece.html#ae696e3d3041f9dd79f82ffda0417f3e4">Piece::setPlayer</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>player</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the owner of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">player</td><td>The owner of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a6d5a10260ce443eced0a02d3df230568"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_piece.html#a6d5a10260ce443eced0a02d3df230568">Piece::setType</a> </td>
          <td>(</td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>type</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Sets the type of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The type of the <a class="el" href="class_piece.html" title="A Piece class.">Piece</a>. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>include/<a class="el" href="_piece_8h_source.html">Piece.h</a></li>
<li>src/Piece.cpp</li>
</ul>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Sat May 12 2012 03:23:28 for Board game project by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>

</body>
</html>
